com.highdeal.admin.hci

Class InstanceId

java.lang.Object

com.highdeal.admin.hci.InstanceId

All Implemented Interfaces:

Comparable<InstanceId>

public final class InstanceId
extends Object
implements Comparable<InstanceId>

This Java class represents a classification for the instances in a deployed SAP CC Core Server system; This classification identifies a system instance by an instance type associated to a number that identifies the instances of the same type. This number is positive and not null and is defined at installation time.

Examples

• dispatcher#1
• rater#1

Note

This classification is defined for an SAP CC system. If your system landscape includes two SAP CC systems, two instances may have the same identifier, but belonging to different SAP CC systems. For example dispatcher#1 and rater#1 are present on both SAP CC systems.

See Also:

InstanceType, InstanceMap

Field Summary

Fields

Modifier and Type	Field and Description
static char	SEPARATOR The string representation of the separator used in the syntax of an instance ID: '#' Refer to the marshal() and unmarshal() methods
static InstanceId	UPDATER_ID Instance ID of the updater instance of the SAP CC system

Method Summary

Modifier and Type	Method and Description
int	compareTo(InstanceId other)
boolean	equals(Object obj)
static InstanceId	getInstanceId(InstanceType instanceType, int instanceNum) Returns an InstanceId object built from the specified instance type and a positive number
int	getInstanceNum() Returns the number of an instance with the same type.
InstanceType	getInstanceType() Returns the instance type of the current instance ID.
int	hashCode()
static String	marshal(InstanceId instanceId) Marshals the InstanceId object into a string; The string result has the following syntax: <INSTANCE_TYPE>SEPARATOR<NUMBER>
static void	marshal(InstanceId instanceId, com.highdeal.hmi.DataBuffer buffer) Marshals the InstanceId object into the specified data buffer.
String	toString()
static InstanceId	unmarshal(com.highdeal.hmi.IDataBuffer buffer) Extracts an InstanceId object from the data buffer specified as argument.
static InstanceId	unmarshal(String instanceId) Unmarshals the string representation of an instance ID into an InstanceId object; The string argument have to respect the following grammar: <INSTANCE_TYPE>SEPARATOR<NUMBER>

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEPARATOR

public static final char SEPARATOR

The string representation of the separator used in the syntax of an instance ID: '#' Refer to the marshal() and unmarshal() methods

See Also:

Constant Field Values

UPDATER_ID

public static final InstanceId UPDATER_ID

Instance ID of the updater instance of the SAP CC system

Method Detail

getInstanceType

public InstanceType getInstanceType()

Returns the instance type of the current instance ID.

Returns:

The instance type

getInstanceNum

public int getInstanceNum()

Returns the number of an instance with the same type.

Returns:

The number of instance

compareTo

public int compareTo(InstanceId other)

Specified by:

compareTo in interface Comparable<InstanceId>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

marshal

public static final String marshal(InstanceId instanceId)
                            throws IllegalArgumentException

Marshals the InstanceId object into a string; The string result has the following syntax: <INSTANCE_TYPE>SEPARATOR<NUMBER>

Parameters:

instanceId - The instanceId to marshal

Returns:

The string representation of the instanceId given in argument

Throws:

IllegalArgumentException - when the argument is null

unmarshal

public static final InstanceId unmarshal(String instanceId)
                                  throws IllegalArgumentException,
                                         NumberFormatException

Unmarshals the string representation of an instance ID into an InstanceId object; The string argument have to respect the following grammar: <INSTANCE_TYPE>SEPARATOR<NUMBER>

Parameters:

instanceId - The result instanceId object

Returns:

The instance identifier corresponding to the argument

Throws:

IllegalArgumentException - When the string argument does not respect the format or is null

NumberFormatException - When the second part of the string is not a positive number

marshal

public static final void marshal(InstanceId instanceId,
                                 com.highdeal.hmi.DataBuffer buffer)
                          throws IllegalArgumentException,
                                 BufferOverflowException

Marshals the InstanceId object into the specified data buffer.

Parameters:

instanceId -

buffer - The result data buffer

Throws:

IllegalArgumentException - When one is null

BufferOverflowException - If the buffer has not at least six bytes free

unmarshal

public static final InstanceId unmarshal(com.highdeal.hmi.IDataBuffer buffer)
                                  throws IllegalArgumentException,
                                         BufferUnderflowException

Extracts an InstanceId object from the data buffer specified as argument.

Parameters:

buffer - The input data buffer

Returns:

The InstanceId object extracted from the buffer

Throws:

IllegalArgumentException - When the data buffer is null

BufferUnderflowException - If the buffer has not at least six bytes remaining

getInstanceId

public static final InstanceId getInstanceId(InstanceType instanceType,
                                             int instanceNum)
                                      throws IllegalArgumentException

Returns an InstanceId object built from the specified instance type and a positive number

Parameters:

instanceType - From the InstanceType

instanceNum - A positive number

Returns:

The InstanceId object built

Throws:

IllegalArgumentException - When the instanceType is null or instanceNum is not positive and not null